<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class VersionHistory</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Interface VersionHistory</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A <a href="../../phpContentRepository/Level2/VersionHistory.html">VersionHistory</a> object wraps an nt:versionHistory  <a href="../../phpContentRepository/Node.html">Node</a>. It provides convenient access to version history information.</p>
	<ul class="tags">
				<li><span class="field">copyright:</span> Copyright &amp;copy; 2004-2005, Domain51</li>
				<li><span class="field">author:</span> PHP - Travis Swicegood &lt;<a href="mailto:travis@domain51.net">travis@domain51.net</a>&gt;</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_version_VersionHistory_interface_php.html">/version/VersionHistory.interface.php</a> (line <span class="field">37</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
								
				<div class="method-definition">
											<span class="method-result">object
 A</span>
										<a href="#getAllVersions" title="details" class="method-name">getAllVersions</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">object
 A</span>
										<a href="#getRootVersion" title="details" class="method-name">getRootVersion</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">object
 A</span>
										<a href="#getVersion" title="details" class="method-name">getVersion</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$retrieve</span>)
									</div>
								
				<div class="method-definition">
											<span class="method-result">object
 A</span>
										<a href="#getVersionByLabel" title="details" class="method-name">getVersionByLabel</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>)
									</div>
							</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodgetAllVersions" id="getAllVersions"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getAllVersions</span> (line <span class="line-number">64</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns an iterator over all the versions within this version history.</p>
<p class="description"><p>The order of the returned objects will not necessarily correspond to the  order of versions in terms of the successor relation. To traverse the  version graph one must traverse the jcr:successor REFERENCE  properties starting with the root version.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> <a href="../../phpContentRepository/Level2/VersionIterator.html">VersionIterator</a> object.</li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">throws:</span> <a href="../../phpContentRepository/Exceptions/RepositoryException.html">RepositoryException</a>    If an error occurs.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object
 A</span>
		<span class="method-name">
			getAllVersions
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodgetRootVersion" id="getRootVersion"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getRootVersion</span> (line <span class="line-number">48</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the root version of this version history.</p>
	<ul class="tags">
				<li><span class="field">return:</span> <a href="../../phpContentRepository/Level2/Version.html">Version</a> object.</li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">throws:</span> <a href="../../phpContentRepository/Exceptions/RepositoryException.html">RepositoryException</a>    If an error occurs.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object
 A</span>
		<span class="method-name">
			getRootVersion
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodgetVersion" id="getVersion"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getVersion</span> (line <span class="line-number">90</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Retrieves a particular version from this version history by its name or  date.</p>
<p class="description"><p><strong>PHP Note</strong>: As PHP does not offer a Calendar class as a core part  of its distribution, $date can not be an object.  It must be  formatted according to the  <a href="http://www.w3.org/TR/NOTE-datetime">ISO8601 specifications</a>.  At  some future point, phpCR may offer a simple Calendar object to encapsulate  this parameter, at which time this will require an object for the  parameter.</p><p><strong>PHP Note</strong>: A simple preg_match() can determine if  $retrieve is a date.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> <a href="../../phpContentRepository/Level2/Version.html">Version</a> object.</li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">throws:</span> <a href="../../phpContentRepository/Exceptions/RepositoryException.html">RepositoryException</a>    If an error occurs.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object
 A</span>
		<span class="method-name">
			getVersion
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$retrieve</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$retrieve</span><span class="var-description">: A version name or date</span>			</li>
				</ul>
		
		
	</div>
<a name="methodgetVersionByLabel" id="getVersionByLabel"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getVersionByLabel</span> (line <span class="line-number">104</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Retrieves a particular version from this version history by version label.</p>
	<ul class="tags">
				<li><span class="field">return:</span> <a href="../../phpContentRepository/Level2/Version.html">Version</a> object.</li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">throws:</span> <a href="../../phpContentRepository/Exceptions/RepositoryException.html">RepositoryException</a>    If an error occurs.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object
 A</span>
		<span class="method-name">
			getVersionByLabel
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$label</span><span class="var-description">: A version label</span>			</li>
				</ul>
		
		
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Fri, 31 Dec 2004 10:15:26 -0600 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a>
	</p>
	</div></body>
</html>